feat: [XD-47]: Initial effort for component library docs #617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for harness-xd-review ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
knagurski
force-pushed
the
xd-47-component-library-docs
branch
from
f621827 to
bf9c07f
Compare
knagurski
force-pushed
the
xd-47-component-library-docs
branch
2 times, most recently
from
2eee22e to
8dc43d6
Compare
knagurski
force-pushed
the
xd-47-component-library-docs
branch
from
8dc43d6 to
093ed08
Compare
abhinavrastogi-harness
approved these changes
Jan 7, 2025
| @@ -131,7 +131,7 @@ | |||
| "jsdom": "^25.0.1", | |||
| "lint-staged": "^15.2.9", | |||
| "tailwindcss": "^3.4.14", | |||
| "typescript": "^5.5.3", | |||
| "typescript": "~5.6.2", | |||
There was a problem hiding this comment.
do we need this upgrade as part of this PR?
any expected issues with this? not sure if other packages are using the same versions yet.
There was a problem hiding this comment.
Good point. I was seeing an issue reported in the console when I was integrating stuff. I'll revert and change to ~ since TS doesn't really do semver (annoyingly).
There was a problem hiding this comment.
Actually, just looking at the output of pnpm why typescript and it looks like we're actually using TS 5.7.2 across the board
Legend: production dependency, optional only, dev only
harness-canary /Users/knagurski/development/canary
devDependencies:
@typescript-eslint/eslint-plugin 6.5.0
├─┬ @typescript-eslint/parser 6.5.0 peer
│ ├─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
├─┬ @typescript-eslint/type-utils 6.5.0
│ ├─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ ├─┬ @typescript-eslint/utils 6.5.0
│ │ └─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
├─┬ @typescript-eslint/utils 6.5.0
│ └─┬ @typescript-eslint/typescript-estree 6.5.0
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
├─┬ ts-api-utils 1.3.0
│ └── typescript 5.7.2 peer
└── typescript 5.7.2 peer
@typescript-eslint/parser 6.5.0
├─┬ @typescript-eslint/typescript-estree 6.5.0
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└── typescript 5.7.2 peer
eslint-import-resolver-typescript 3.6.3
├─┬ eslint-module-utils 2.12.0
│ └─┬ @typescript-eslint/parser 6.5.0 peer
│ ├─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└─┬ eslint-plugin-import 2.31.0 peer
├─┬ @typescript-eslint/parser 6.5.0 peer
│ ├─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└─┬ eslint-module-utils 2.12.0
└─┬ @typescript-eslint/parser 6.5.0 peer
├─┬ @typescript-eslint/typescript-estree 6.5.0
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└── typescript 5.7.2 peer
eslint-plugin-import 2.31.0
├─┬ @typescript-eslint/parser 6.5.0 peer
│ ├─┬ @typescript-eslint/typescript-estree 6.5.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└─┬ eslint-module-utils 2.12.0
└─┬ @typescript-eslint/parser 6.5.0 peer
├─┬ @typescript-eslint/typescript-estree 6.5.0
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└── typescript 5.7.2 peer
eslint-plugin-tailwindcss 3.17.5
└─┬ tailwindcss 3.4.15 peer
└─┬ postcss-load-config 4.0.2
└─┬ ts-node 10.9.2 peer
└── typescript 5.7.2 peer
typescript-eslint 8.14.0
├─┬ @typescript-eslint/eslint-plugin 8.14.0
│ ├─┬ @typescript-eslint/parser 8.14.0 peer
│ │ ├─┬ @typescript-eslint/typescript-estree 8.14.0
│ │ │ ├─┬ ts-api-utils 1.3.0
│ │ │ │ └── typescript 5.7.2 peer
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ ├─┬ @typescript-eslint/type-utils 8.14.0
│ │ ├─┬ @typescript-eslint/typescript-estree 8.14.0
│ │ │ ├─┬ ts-api-utils 1.3.0
│ │ │ │ └── typescript 5.7.2 peer
│ │ │ └── typescript 5.7.2 peer
│ │ ├─┬ @typescript-eslint/utils 8.14.0
│ │ │ └─┬ @typescript-eslint/typescript-estree 8.14.0
│ │ │ ├─┬ ts-api-utils 1.3.0
│ │ │ │ └── typescript 5.7.2 peer
│ │ │ └── typescript 5.7.2 peer
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ ├─┬ @typescript-eslint/utils 8.14.0
│ │ └─┬ @typescript-eslint/typescript-estree 8.14.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
├─┬ @typescript-eslint/parser 8.14.0
│ ├─┬ @typescript-eslint/typescript-estree 8.14.0
│ │ ├─┬ ts-api-utils 1.3.0
│ │ │ └── typescript 5.7.2 peer
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
├─┬ @typescript-eslint/utils 8.14.0
│ └─┬ @typescript-eslint/typescript-estree 8.14.0
│ ├─┬ ts-api-utils 1.3.0
│ │ └── typescript 5.7.2 peer
│ └── typescript 5.7.2 peer
└── typescript 5.7.2 peer
That's from current main
I'll leave everything as-is for now and open another PR to standardise with ~ across all apps/packages.
There was a problem hiding this comment.
Running in the ui package directly shows that 5.6.3 was the version being used. So this line's change from ^5.5.3 to ~5.6.2 has no effect ¯\(ツ)/¯
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the initial (and mostly unstyled) version of the component docs app.